Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add dev docs for swift sdk #537

Merged
merged 5 commits into from
Dec 18, 2023
Merged

chore: add dev docs for swift sdk #537

merged 5 commits into from
Dec 18, 2023

Conversation

anitarua
Copy link
Collaborator

@anitarua anitarua commented Dec 5, 2023

Swift dev docs to address momentohq/client-sdk-swift#56

@anitarua anitarua marked this pull request as ready for review December 14, 2023 17:43
@anitarua
Copy link
Collaborator Author

@poppoerika I'm not sure how to get the Translate CI job to pass. I copied the new files to the Japanese translation section as well, but I can remove them if that's not necessary

Copy link
Contributor

@pgautier404 pgautier404 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're not getting any syntax highlighting for the Swift code. @cprice404 is there something we need to do to enable that?

It also looks like the snippets in the API reference for publish and subscribe aren't showing their tabs. The topic client snippet is showing up fine, though it is also missing syntax highlighting.

The last thing I noticed was there are no snippets for the list operations, but since there are currently only Javascript snippets for those APIs anyhow, that doesn't really seem like a blocker.

@cprice404
Copy link
Contributor

We're not getting any syntax highlighting for the Swift code. @cprice404 is there something we need to do to enable that?

It also looks like the snippets in the API reference for publish and subscribe aren't showing their tabs. The topic client snippet is showing up fine, though it is also missing syntax highlighting.

The last thing I noticed was there are no snippets for the list operations, but since there are currently only Javascript snippets for those APIs anyhow, that doesn't really seem like a blocker.

you will want to check this out:

additionalLanguages: ["java", "rust", "csharp", "php", "elixir"],

You may have to look in the docusaurus (or related plugin) docs to see if swift is supported, but if it is, it will almost certainly need to be added there.

I haven't reviewed this PR, but if there are any other issues with the snippets showing up then there may be a few things we need to add/fix on the react components and associated plugin .ts files to make sure we've added the new language.

I agree that none of these necessarily need to block this PR, fine to make incremental progress.

@anitarua
Copy link
Collaborator Author

anitarua commented Dec 18, 2023

Added swift to the docusaurus config list and syntax highlighting works now.

The snippet issues should be fixed once this goes in (it was due to mismatch in snippet IDs): momentohq/client-sdk-swift#113

Made a ticket to add list collection type snippets in future: momentohq/client-sdk-swift#114

@pgautier404 pgautier404 self-requested a review December 18, 2023 21:37
@anitarua
Copy link
Collaborator Author

@cprice404 do you know how I might be able to get the Japanese translation task to pass? or possibly disable it for this PR or something?

@anitarua anitarua merged commit e2eb6ed into main Dec 18, 2023
3 of 4 checks passed
@anitarua anitarua deleted the swift-docs branch December 18, 2023 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants